ODBC Driver for MongoDB

Connection String Parameters - ODBC Driver for MongoDB

MongoDB ODBC Connection String Parameters

The following table lists the connection string parameters for MongoDB.

Parameter Description

Data Source

Serves to supply the server name for login.

Port

Used to specify the port number for the connection. 27017 by default.

User ID

Used to supply a unique User ID for login.

Password

Used to supply a password for login.

Database

Used to set the name of the database.

Client Library

Used to specify the libmongoc client library location.

BSON Library

Used to specify the libbson client library location.

Allow Add Fields

If True, then when editing an existing document, it allows to add new fields to the document. True by default.

Complex As String

If True, then complex fields of a document (which are of object, array, timestamp, binary, regular expression or JavaScript type) are mapped as a single string field and their content is displayed in the Extended JSON format. If False, such fields are mapped as a set of their child fields. False by default.

Lowercase ObjectId

If False (default), then ObjectId will be presented in uppercase. If True, it will be presented in lowercase.

Describe Amount

Specifies the number of sample documents used to create a list of fields in the dataset. The default value is 25.

Additional Servers

Specifies additional servers to connect to, separated by commas. Each server has to be specified in the host[:port] format as it is described in the official MongoDB documentation.

Connection Options

Connection specific options. See official MongoDB documentation for a full description of these parameters.

Advanced Settings

Allow NULL strings

To retrieve metadata, not all parameters according to MSDN can accept a null value. If NULL, the driver should return an error. But some 3rd-party tools pass NULL to the parameters. These parameters should be enabled for compatibility with such tools.

Empty strings as NULL

ODBC Behavior

Used to set the behavior corresponding to the ODBC specification version that a third-party tool expects. The behavior of ODBC driver can be changed by setting a value for the SQL_ATTR_ODBC_VERSION attribute by calling the SQLSetEnvAttr function. But some third-party tools expect the driver to exhibit ODBC 2.x behavior, but forget to call SQLSetEnvAttr with the specified version or pass an incorrect value there. In this case, the required behavior can be explicitly specified in the Connection String by setting the ODBC Behavior parameter. The possible values are:

  • Default - default ODBC behavior determined by a third-party tool.
  • Ver 2.x - ODBC 2.x behavior is explicitly set.
  • Ver 3.x - ODBC 3.x behavior is explicitly set.

String Types

Sets the string value types returned by the driver as Default, Ansi or Unicode.

  • Default - the driver defines the string types.
  • Ansi - all string types will be returned as SQL_CHAR, SQL_VARCHAR and SQL_LONGVARCHAR.
  • Unicode - all string types will be returned as SQL_WCHAR, SQL_WVARCHAR and SQL_WLONGVARCHAR.

The parameter value should be changed if any third-party tool supports only Ansi string types or Unicode ones.

RegionalNumberSettings

Enables the use of local regional settings when converting numbers to strings.

RegionalDateTimeSettings

Enables the use of local regional settings when converting dates and times to strings.

Sample MongoDB ODBC Connection String

DRIVER={Devart ODBC Driver for MongoDB};Data Source=myServer;Port=myPort;Database=myDatabase;User ID=myUsername;Password=myPassword

See also:

© 2015-2024 Devart. All Rights Reserved. Request Support ODBC Forum Provide Feedback